home *** CD-ROM | disk | FTP | other *** search
/ Belgian Amiga Club - ADF Collection / BS1 part 34.zip / BS1 part 34 / FredFish PD 301.adf / Aquarium / Aquarium.doc < prev    next >
Text File  |  1990-01-10  |  10KB  |  286 lines
  1. ***************************************************************************
  2. ***************************************************************************
  3.  
  4.         Aquarium (c) B Lennart Olsson 1989 - All Rights Reservered.
  5.         NewFish (c) B Lennart Olsson 1988 - All Rights Reservered.
  6.  
  7. ***************************************************************************
  8. ***************************************************************************
  9.  
  10. Aquarium and NewFish may be copied and redistributed without any additional
  11. permission, provided that no charge is requested for it's use and that
  12. this information is included.
  13.  
  14. Special thanks to Niclas Persson, who supported in many ways.
  15.  
  16. ***************************************************************************
  17.  
  18. 0.  Contents.
  19. -------------
  20.     1.  Intro
  21.     2.  Installation
  22.     3.  Search methods
  23.     4.  Search mode and program mode
  24.     5.  Navigation gadgets
  25.     6.  Project menu
  26.     7.  Hardcopy menu
  27.     8.  Break-"gadget"
  28.     9.  Key philosophy
  29.     10. Files in data directory
  30.     11. Future revisions of Aquarium
  31.     12. Using NewFish
  32.     13. Version history
  33.  
  34.  
  35.  
  36. 1.  Intro.
  37. ----------
  38.     Aquarium is a program intended for searching through a special
  39.     database containing information of the contents in Fred Fish's 
  40.     AmigaLibDisks, in order to find programs etc with specified features.
  41.  
  42.     NewFish is a program that appends the contents files to the database.
  43.     --- WARNING! Read this doc before you attempt to run this program;
  44.     it just might make your database useless if not handled with care.
  45.     A future revision will take care of this problem.
  46.  
  47.  
  48.  
  49. 2.  Installation.
  50. -----------------
  51.     There is nothing special about it: just be sure you have Aquarium
  52.     and the data directory in the same directory level, and if you're
  53.     running it from the CLI you must be in the same directory. See also
  54.     10: about the files in data.
  55.  
  56.  
  57.  
  58. 3.  Search methods.
  59. -------------------
  60.     The program searches through the database in three ways: Keys, sub-
  61.     string in program name and substring in the describing text.
  62.  
  63.     a: All the requested keys must be defined in the investigated item,
  64.        otherwise it continues with the next.
  65.  
  66.     b: If the keys are allright it scannes the item name for the sub-
  67.        string ( not case sensitive) specified in the string-gadget 'name'.
  68.        If this fails it continues with the next item.  
  69.  
  70.     c: The sub-string specified in the string-gadget 'text' is used for
  71.        a search in the describing text in the same way as in b.
  72.  
  73.     A special feature is included with the 'name' gadget: You may jump to
  74.     a disk directly by giving the disk number after a '/'. Example: '/150'.
  75.     (Not a beauty, but it works.)
  76.  
  77.     Note that if you're in programming mode no search operations are 
  78.     performed.
  79.  
  80.  
  81.  
  82. 4.  Search mode and program mode.
  83. ---------------------------------
  84.     In search mode you setup the keys by clicking on the keywords and a
  85.     navigation gadget. In program mode the setting of a key will change
  86.     the database directly.
  87.  
  88.     Programming mode is recognized by a red screen and by a special image
  89.     for the mode-gadget.
  90.  
  91.  
  92.  
  93. 5.  Navigation gadgets.
  94. -----------------------
  95.     Double left arrows:
  96.         With this gadget you move directly to the beginning of the
  97.         database.
  98.  
  99.     Left and right arrow:
  100.         With these gadgets you searches the database towards the beginning 
  101.         resp. the end for a match. In programming mode you only take one 
  102.         step in that direction.
  103.  
  104.     Printer:
  105.         Make a hardcopy of the showed item, using the settings in the 
  106.         Hardcopy menu.
  107.  
  108.     Right gadget with open lock:
  109.         Search the database for the next item which does not have any keys
  110.         specified.
  111.  
  112.     Mode gadget:
  113.         Switches between search mode and program mode. In program mode the 
  114.         screen turns red and in search mode green-blue.
  115.  
  116.  
  117. 6.  Project menu.
  118. -----------------
  119.     About:
  120.         About Aquarium and me.
  121.  
  122.     Save:
  123.         Save the changes to disk.
  124.  
  125.     Save & Quit:
  126.         Save changes, if any, and quit THIS program.
  127.  
  128.  
  129. 7.  Hardcopy menu.
  130. ------------------
  131.     Options:
  132.         Include text:
  133.             The describing text is included in all printouts.
  134.  
  135.         Sorted list:
  136.             Normally, when a printed search is started, the program prints
  137.             directly any found item. With this option enabled it first puts 
  138.             them in a buffer, sorts them when end of file is reached, and
  139.             then prints them.
  140.  
  141.         Formfeeds:
  142.             With this enabled it send a FormFeed character to the printer
  143.             whenever a new page is to start. Otherwise it sends linefeeds
  144.             according to the settings in preferences.
  145.  
  146.     Count them:
  147.         Search through the database, beginning at the top, count the
  148.         matches  and show the result in the text field.
  149.  
  150.     New Page:
  151.         Start a new page.
  152.  
  153.     Print:
  154.         Search through the database and print the matching items.
  155.  
  156.  
  157. 8.  Break-"gadget".
  158. -------------------
  159.     When time consuming actions take place, like searching for substring
  160.     in the text or printing, you'll find that a special gadget appears in
  161.     the text field. Clicking in the neighbourhood of this will stop the
  162.     current action.
  163.  
  164.  
  165.  
  166. 9.  Key philosophy.
  167. -------------------
  168.     We have tried to make the keys self-explanatory and the settings
  169.     logical and consequent, but there are a few things that can help you
  170.     understand the philosophy:
  171.  
  172.         a:  IFF pictures and such - Data & Graphics
  173.         b:  Sound files           - Data & Sound
  174.         c:  Fonts                 - Data, Text processing & Graphics
  175.         d:  The Subroutine key stands for librarys and useful routines
  176.             in general.
  177.         
  178.     There are some unused keys that you can use for your own purpose.
  179.     Just put the names in the file 'KeyNames' in the 'Data' directory.
  180.  
  181.  
  182.  
  183. 10. Files in data directory.
  184. ----------------------------
  185.     The data directory must reside in the same directory as Aquarium.
  186.     If you run this program from CLI, you must make this your current
  187.     directory. You don't have to make any assignments.
  188.  
  189.     Data:
  190.         This file contains the describing text only.
  191.  
  192.     Index:
  193.         Contains the keys and pointers to data file.
  194.  
  195.     Names:
  196.         Contains item names.
  197.  
  198.     KeyNames:
  199.         Contains the key names appearing in the key-gadgets.
  200.  
  201.  
  202.  
  203. 11. Future revisions of Aquarium.
  204. ----------------------------------
  205.     If you have any suggestions or thoughts around this program,
  206.     please let me know.
  207.  
  208.  
  209.  
  210. 12. Using NewFish.
  211. -----------------
  212.     NewFish is a program to read the contents files of the Fish's disks
  213.     and append them to Aquarium's database.
  214.  
  215.     WARNING:
  216.     You MUST take a backup copy of all files in the data directory
  217.     before you run NewFish. This program is not very smart and if it failes
  218.     to interpret the contents file correctly and you accept the result,
  219.     there is NO WAY to delete the incorrect item from the data base.
  220.  
  221.     The program reads the contents file and tries to extract the different
  222.     items from the text. For each item it asks you if it is OK and then
  223.     saves it directly to disk. A problem might occure if the file is only
  224.     partly correct and you abort the program. This leaves you with an
  225.     uncomplete disk in the database. To correct the situation you must edit
  226.     a version of the contents file and delete those items already appended.
  227.  
  228.     A file with no separatable items will be read as one item and called
  229.     Diskxxx.
  230.  
  231.     Make a hardcopy of all the contents files before you tries to append
  232.     them. Read them carefully and check if the following rules applies.
  233.  
  234.     a:  A contents file with separate items is allowed to have a multi
  235.         line comment in the beginning, if all the lines starts at the
  236.         first column.
  237.  
  238.     b:  The items must be separated by a blank line.
  239.  
  240.     c:  An items first line must start in the first column and the lines
  241.         there after must start with a tab or spaces.
  242.  
  243.     d:  A contents file that are to be interpreted as one item only must
  244.         not contain any white spaces at the beginning of lines if it
  245.         shall be correctly interpreted. You may try to read it with NewFish
  246.         to see if it reads correct. You will be noted if the program treats
  247.         it as a disk item or not. Just abort if it separate it into
  248.         different items.
  249.  
  250.     In some way I'll make this program easier to use. It's just to
  251.     silly the way it is now.
  252.  
  253.  
  254.  
  255. 13. Version history.
  256. --------------------
  257.     Aquarium 1.11:
  258.         Changes that make it easier to compile for another language by
  259.         linking with a special text file. This also applies for the
  260.         names of files. The program will use the names specified in
  261.         the text file and if these don't work, it tries the default
  262.         Swedish names and thereafter the English names.
  263.  
  264.         Centering of key names did not work if the line in the key-name
  265.         file ended directly after the name. Now it does.
  266.  
  267.         Save caused the program to start at the beginning of the data
  268.         base. Changed.
  269.  
  270.         The disk number option in the name gadget did not always work.
  271.         This bug is now removed.
  272.  
  273.     Aquarium 1.12:
  274.         A minor internal enhancement.
  275.  
  276. --------------------------------------------------------------------------
  277.  
  278. That's all. If you have any suggestions or thoughts around this program,
  279.             please don't hesitate to contact me.
  280.  
  281.                 B Lennart Olsson
  282.                 Brunnsgatan 8
  283.                 223 60 LUND
  284.                 Sweden
  285.  
  286.